---
name: Guide 指引
---

# Guide 指引

## 说明

import Demo from './Demo';

## Guide API

| Name             | Type     | Default    | Description                                                 |
| :--------------- | :------- | :--------- | :---------------------------------------------------------- |
| autoStart        | Boolean  | false      | 是否自动提示                                                |
| showOnce         | Boolean  | false      | 是否只显示一次, 本地存储记录. 必须同时设置 localStorageKey. |
| localStorageKey  | String   | ''         | 本地存储 key                                                |
| overlay          | Boolean  | false      | 遮罩层, 其他元素不可点击                                    |
| zIndex           | Number   | 1000       | 遮罩层 zIndex                                               |
| finishText       | String   | '我知道了' | 结束按钮的文案                                              |
| nextText         | String   | '继续了解' | 下一步按钮的文案                                            |
| skipText         | String   | '跳过'     | 跳过按钮的文案                                              |
| isShowSkipBtn    | Boolean  | true       | 是否隐藏跳过按钮                                            |
| overlayClickNext | Boolean  | false      | 点击遮罩层是否下一步                                        |
| allowEsc         | Boolean  | true       | 是否开启按下 Esc 键执行下一步                               |
| onStart          | Function | -          | 开始事件                                                    |
| onNext           | Function | -          | 下一步事件                                                  |
| onStop           | Function | -          | 结束事件                                                    |

## Guide.Step API

| Name | Type | Default | Description |
| :-- | :-- | :-- | :-- |
| index | Number | null | 序号, 可以不加, 如果添加会按顺序执行, 重复的序号会在原序号的后面插入 |
| placeholderStyle | StyleObject | {} | 高亮区域的样式 |
| placeholderOffset | Object | {left: -6, top: -6, width: 12, height 12} | placeholderOffset 的偏移量, 默认的偏移量可以视为内边距 |
| finishText | String | '我知道了' | 结束按钮的文案 |
| nextText | String | '继续了解' | 下一步按钮的文案 |
| skipText | String | '跳过' | 跳过按钮的文案 |

## Demo

<Demo />
